###############################################################################
# #
# RCBsc-12.zip: Cannon effect for RealAir Simulations' FS9 Spitfire #
# #
# By Rob Barendregt Release 1.2 5 dec 2004 #
# #
########################################################################

PLEASE, READ THIS MANUAL CAREFULLY BEFORE INSTALLING & USING THIS PACKAGE !!!

TO PRINT:
Open this file in Notepad, and select charactertype: FixedSys, Normal, 9 dots.


1. Functionality
================
This archive contains a visible and audible cannon effect, tailored for the
(in every aspect) truely awsome RealAir Spitfire for FS9.

But, being a big fan of military aircraft, I really missed a cannon effect.
Now, you may argue that cannons/bombs/etc do not belong in a civilian
FlightSimulator like FS9. In that case: just DON'T USE this addon, and stop
reading here... :-)
But, being a piecefull man myself, I made sure that the cannon fire will NOT
damage your scenery or AI aircraft :-)

The package consist of a visual effect, cannon sounds, a control gauge and
a sound gauge. Unlike the RealAir Spitfire itself, this package is freeware.
See section "Copyights and disclaimer".

The cannon is triggered by:
- Mouseclicking the Gunswitch on the control column in the panel.
- The key or joystickbutton assigned to the FS command "Reheat/Afterburner
On/Off". See also section "Key/Button configuration".
A single "trigger" will release a short burst of cannon fire; when you keep
the mousebutton / key / joystickbutton depressed, the cannon will fire
continously.

I deliberately chose NOT to distribute adapted RealAir files, simply because
you (or later: RealAir) may have made changes to them yourself (which would
then be lost). Although manually adding gauges and effects to existing
aircraft may sound complicated: it isn't, if you just follow the instructions!
Besides, you might learn something from this manual process :-)
So installing this package REQUIRES some basic knowledge of handling files
and folders in Windows, and the ability to edit existing .cfg files with a
simple text editor like Notepad.


2. Installation.
================

1. Extract all files to a temporary folder.

2. Then, MOVE:

- To folder ...\Flight Simulator 9\Effects\ :
- File SpitfireCannon.fx
- To folder ...\Flight Simulator 9\Effects\Texture\ :
- File SpitfireCannon.bmp
- To folder ...\Flight Simulator 9\Sound\ :
- File SpitfireCannon.wav
- File SpitfireCannonLowVolume.wav
- File SpitfireCannonFade.wav
- To folder ...\Flight Simulator 9\Gauges\ :
- File SpitfireSound.gau
- To folder ...\Flight Simulator 9\Gauges\rcb-gauges\ :
- File SpitfireCannonControl.xml
- File SpitfireSound.ini
- This README file.
Note: If this subfolder \rcb-gauges\ doesnot exists yet, create it first.
E.g. with Windows Explorer.

3. With Windows Notepad, open the panel.cfg file in folder
...\Flight Simulator 9\Aircraft\RealAir Spitfire XIV\Panel\
and add to the [VCockpit01] section (after gauge10= ):

gauge11=SpitfireSound!dsd_xml_sound3, 0,0,,, ./gauges/rcb-gauges/SpitfireSound.ini
gauge12=rcb-gauges!SpitfireCannonControl, 0,0

And save the file.
TIP1: Use Windows Copy&Paste to avoid typing errors.
TIP2: For safety: ALWAYS BACKUP A FILE BEFORE YOU EDIT IT !!!!

4. Simularly, open the aircraft.cfg file in folder
...\Flight Simulator 9\Aircraft\RealAir Spitfire XIV\
and add to the [LIGHTS] section (after light.15= ):

// Cannon effects--------------------------RCB-----------
light.16= 10, 1.5, 7.3, -1.9, SpitfireCannon
light.17= 10, 1.5, -7.3, -1.9, SpitfireCannon


Now startup FS9, select the aircraft variation "Elliptical Wing, RB159"
and press the key assigned to the FS9 function "Reheat/Afterburner On/Off"
(default: Shift-F4).
You should see the cannon effect from both wing cannons (in all views) and
hear the sounds via your speakers.
Especially in SpotPlane view, observe the smoke, tracer and falling shells..

NOTE:
If you want the effect in all Spitfire variations, repeat step-4 for
each aircraft.cfg file in all RealAir Spitfire folders.


3. Key/Button configuration in FS9
==================================
In the FS9 menu, select Options - Controls - Assignments, select the
appropriate "Joystick type", and scroll in the "Assignments list" to
function "Reheat/Afterburner On/Off".
You can change the assigned key or controller-button if you like.
If you assign a controller button, make sure that the "repeat" slider is
set to Max., so that that keeping the button depressed will continuously
generate "Reheat/Afterburner On/Off" commands.
For the keyboard key, this is automatically done because of
the "repeat" function of your keyboard.

Should you use any other hardware device as a trigger that generates
"Reheat" commands: make sure it generates at least 8 commands/sec. if you
keep the trigger depressed. If not, the repeat function (causing the effect
to be lengthened to the depress duration) will NOT work properly.
The same applies if you make the assignment via the key/button facility of
FSUIPC, instead of directly in FS9.


4. Known limitations
====================
1. When you trigger the cannons via mouseclicking the gunswitch on the
panel, it can happen that the cannon doesnot react. This is caused by
the internal scheduling process in FS9.
REMEDY: hold the mousebutton depressed for at least 150 msec.
2. One, or both, cannon effects may not be visible immediately after you
trigger the cannon. Or, at low framerates, may not be visible at all.
This is just a limitation of the "effects engine" in FS9, and cannot be
solved.
3. The volume of the cannon sound CANNOT be influenced via the FS9 sound
setting menu. Meaning that if you, for example, reduce the engine sound
volume (menu Options - Settings - Sounds) the cannon will sound relatively
louder.
Alternatively, you can use the low-volume version of the cannon sound:
- Exit FS9.
- Rename file SpitfireCannon.wav to SpitfireCannonHighVolume.wav
- Rename SpitfireCannonLowVolume.wav to SpitfireCannon.wav
4. Although you can use this effect in other aircraft as well, of course
this will only work if this aircraft doesn't have an Afterburner function.
Just find out the proper "gun-positions" in the aircraft.cfg.
And obviously, there's no way to trigger the effect by mouseclicking on
the panel (which is specific for the Spitfire). Unless you make your own
XML gauge doing this :-)


5. Copyrights and Disclaimer
============================
This package is freeware, and is available for your personal use.
Without my explicite permission, it may NOT be sold, re-distributed and/or
uploaded to another website/bulletin board/CDROM in ANY shape or form.

And obviously, installing & using this package is at your own risk.
This also means, that if, after installing this package, you should
experiance problems with the Spitfire aircraft, RealAir Simulations should
NOT be asked for support !!
However, if you execute the Installation instructions properly, this package
will NOT crash you PC or FS, nor will it have an noticeable impact on
performance.



6. Credits
==========
- RealAir Simulations, for their fantastic Spitfire product.
- Doug Dawson, for his perfect solution to play sounds from an XML gauge.
SpitfireSound.gau is just a renamed version of dsd_xml_sound3.gau
- Jan Rosenberg, for his visual Cannon effect (an enhanced version of
a CFS2 effect)



Enjoy ......

Rob Barendregt, The Netherlands
Email: rc.barendregt@planet.nl


***************************** END OF DOCUMENT *******************************